add doc comment for execution stage struct #80
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jayshrivastava
approved these changes
Aug 6, 2025
NGA-TRAN
approved these changes
Aug 6, 2025
src/stage/stage.rs
Outdated
| /// When an [`ExecutionStage`] is execute()'d if will execute its plan and return a stream | ||
| /// of record batches. | ||
| /// | ||
| /// If the stage has input stages, then it those input stages will be executed on remote resources |
Collaborator
There was a problem hiding this comment.
Suggested change
| /// If the stage has input stages, then it those input stages will be executed on remote resources | |
| /// If the stage has input stages, those input stages will be executed on remote resources |
| /// If the stage has input stages, then it those input stages will be executed on remote resources | ||
| /// and will be provided the remainder of the stage tree. | ||
| /// | ||
| /// For example if our stage tree looks like this: |
Collaborator
There was a problem hiding this comment.
The sentence does not sound finish
src/stage/stage.rs
Outdated
| /// | ||
| /// The receiving ArrowFlightEndpoint will then execute Stage 2 and will repeat this process. | ||
| /// | ||
| /// When Stage 4 4 is executed, it has no input tasks, so it is assumed that the plan included in that |
Collaborator
There was a problem hiding this comment.
Suggested change
| /// When Stage 4 4 is executed, it has no input tasks, so it is assumed that the plan included in that | |
| /// When Stage 4 is executed, it has no input tasks, so it is assumed that the plan included in that |
Collaborator
Author
|
Thanks for these @NGA-TRAN ! I addressed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Re-add back doc comment for execution stage struct.